Appendix A: CMP Default Fields and Beans

The following table lists and describes the available default fields in CMPClosed Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers..

Default Field Description
ACCOUNTAMOUNTDUE This returns the balance on the account that is currently due.
ACCOUNTAMOUNTINARREARS This returns the amount on the account that is in arrears.
ACCOUNTAMOUNTINQUERY This returns the value of the balance on the account which is in query.
ACCOUNTATTRIBUTE1 This returns the value of account attribute number 1.
ACCOUNTBALANCE This returns the full balance on the account.
ACCOUNTNUMBER This returns the account number of the account or of the subscriptions account.
ACCOUNTSERIALNUMBER1 This returns the value of account serial number 1.
ACCOUNTTYPE This returns the account type of the account.
ACTVTNCODE The QR code for the eSIM provisioned.
ADDRESSLINE1 This returns address line 1.
ADDRESSLINE2 This returns address line 2.
ADDRESSLINE3 This returns address line 3.
ADDRESSLINE4 This returns address line 4.
ADDRESSLINE5 This returns address line 5.
AGREEMENTCONTRACTEXPIRE The date on which an agreement's contracts are due to expire.
CARDLAST4DIGITS This returns the last four digits of the credit card.
CARDEXPIRE The date on which the card is due to expire.
CARDEXPIRYDATE This returns the credit card expiry date.
CHANGINGSUBSERIALNUMBER1 This returns the value of subscription serial number 1.
CONTRACTEXPIRYDATE The date when the contract is due to expire.
CORPORATETOTALAMOUNTDUE This returns the total amount due at the Corporate level.
CORPORATETOTALBALANCE This returns the total balance at the Corporate level.
CURRENTPRICEPLAN This returns the current price plan.
CURRENTPRICEPLANCHARGE The recurring charge for the current price plan.
DEARSIRMADAM Static text to appear on letters: Dear Sir/Madam.
ENDEDPACKAGECLASSIFICATION The classification of the package that has been ended.
ENDEDPACKAGEDESCRIPTION The description of the package that has been ended.
ENDEDPACKAGEPRICE The purchase price of the package that has been ended.
ENDEDPACKAGEPURCHASETIMESTAMP The date and time that the package was originally purchased.
EVENTNUMBER This returns the workflow event number.
FORENAME This returns the forename.
FUTUREPRICEPLAN This returns the future price plan.
FUTUREPRICEPLANCHARGE This returns the recurring charge of the future price plan.
GROUPTOTALAMOUNTDUE Group Total amount due.
GROUPTOTALBALANCE This returns the total amount due at the Group level.
LATESTINVOICEAMOUNT The latest amount that has been invoiced.
LATESTINVOICEDUEDATE The payment due date of the latest invoice.
LATESTPRICEPLAN This returns the latest price plan.
LATESTPRICEPLANCHARGE This returns the recurring charge of the latest price plan.
MANUALPAYMENTDUEDATE The date the manual payment is due.
MOBILELONGESTSUBONACCOUNT This returns the mobile number of the longest non prepay sub where smsAllowed is True on the network type.
NETWORKSUBCODE1 This returns the value of subscription network sub code 1.
NEXTINVOICEDATE This returns the date the next invoice is due.
NEXTPAYMENTDATE This returns the date the next payment was made.
NEXTPAYMENTAMOUNT This returns the amount due of the next payment.
NONMANSERIALNUMBER1 This returns the value of non-managed serial number 1.
NONMANSERIALNUMBER2 This returns the value of non-managed serial number 2.
OCSABSOLUTETHRESHOLD This returns the absolute value of the threshold that the notification relates to, for example, 200(MB).
OCSBALANCEID This returns the identifier of the specific allowance balance that the notification relates to.
OCSCYCLEENDDATE This returns the end date of the allowance allocation that the notification relates to.
OCSCYCLELENGTH This returns the length of the refresh interval for the allowance that the notification relates to, for example, 1 Month.
OCSENTITLEMENTNAME This returns the name of the OCS Entitlement that the notification relates to.
OCSENTITLEMENTSIZE This returns the overall inclusive allowance amount that the notification relates to.
OCSOFFERNAME This returns the name of the OCS Offer (allowance name) that the notification relates to.
OCSREMAININGQUOTA This returns the remaining allowance amount that the notification relates to.
OCSSUBSCRIPTIONID This returns the identifier of the OCS subscription that the notification relates to.
OCSUSAGEAMOUNT This returns the amount of allowance consumed that the notification relates to.
OCSVOLUMETHRESHOLDVALUE This returns the amount of allowance consumed that the notification relates to.
ONEOFFBOLTONPACKAGEEXPIRY The date on which the one off bolt-on package is due to expire.
ONETIMEPASSWORD This returns the one time password (OTP).
PACKAGEDESCRIPTION The description of the one off bolt-on package which is due to expire.
PACKAGEEXPIRYDATE The date when the one off bolt-on package is due to expire.
PAYCARDLAST4DIGITS This returns the last four digits of the credit card that made a payment.
PAYMENTACCNUM This returns the CMP account number associated with the payment.
PAYMENTAMOUNT This returns the amount of the payment.
PAYMENTDATETIME This returns the date and time a payment was made.
POSTCODE This returns the postcode of the address.
POSTCONNECTION The date on which to send a notification to new subscriptions after connecting.
PREPAIDACTIVITYFINAL The date on which to send a notification to a prepaid subscription alerting them of their disconnection after failing to purchase a bolt-on or top-up package.
PREPAIDACTIVITYWARNING The date on which to send a communication to a prepaid subscriptions requesting to purchase a bolt-on or top-up package to avoid disconnection.
PREVIOUSPRICEPLAN This returns the previous price plan.
PREVIOUSPRICEPLANCHARGE This returns the recurring charge of the previous price plan.
PURCHASEPACKAGECLASS Type of package purchased.
PURCHASEPACKAGECODE The CMP code for the purchased package.
PURCHASEPACKAGEDESC The description for the purchased package.
PURCHASEPACKAGEPRICE The price of the purchased package.
PURCHASEPACKAGETIME The timestamp for when the package was purchased.
RECPREPAYMENTPRODUCT This returns the recurring prepayment product purchase description.
RECPREPAYMENTDATE This returns the recurring prepayment due date.
RECPREPAYMENTLAST4DIGITS This returns the last four digits of the recurring prepayment purchase.
RECPREPAYMENTAMOUNT This returns the recurring prepayment amount.
RECURRINGPREPAYMENTBALANCE This returns the due date of the prepayment of a recurring bolt-on package paid from the prepaid balance.
RECURRINGPREPAYMENTCARD This returns the amount and due date of the prepayment of a recurring bolt-on package paid by card.
RESOLUTIONREQUIREDBYDATE This returns the Resolution Required By Date of a workflow event.
RESOLVEDDATE This returns the Resolved Date for a workflow event.
SUBALLOWANCEAMOUNT The initial allowance amount allocated for the period on the OCS.
SUBALLOWANCEAMOUNTREMAINING The amount of the allowance remaining on the OCS.
SUBALLOWANCEAMOUNTUSED The amount of the allowance that has been consumed on the OCS.
SUBALLOWANCEDESCRIPTION The description of the allowance associated with the OCS notification.
SUBALLOWANCETYPE The type of the allowance associated with the OCS notification.
SUBCONTRACTENDDATE This returns the date that the contract on the subscription is due to end.
SUBCONTRACTSTARTDATE This returns the date that the current subscription contract commenced.
SUBPASSWORD This field may be used to store a PIN depending on CMP implementation but it will not store a password of any sort.
SUBSCONNECTEDDATE This returns the date that billing commenced.
SUBSCRIPTIONATTRIBUTE1 This returns the value of subscription attribute 001.
SUBSCRIPTIONNUMBER This returns the subscription number of the subscription.
SUBSCRIPTIONCONTRACTEXPIRE This returns the date on which a subscription's contracts are set to expire.
SUBSDISCONNECTEDDATE This returns the date that billing stopped.
SUBSERIALNUMBER1 This returns the value of subscription serial number 1.
SUBSERIALNUMBER2 This returns the value of subscription serial number 2.
SUBSERIALNUMBER3 This returns the value of subscription serial number 3.
SUBSERIALNUMBER4 This returns the value of subscription serial number 4.
SUBSERIALNUMBER5 This returns the value of subscription serial number 5.
SUBSTERMINATIONDATE This returns the date that the termination invoice was produced.
SUBSUSERNAME This returns the username of the subscription.
SUBUSAGECAPAMOUNT The initial spend cap amount defined for the period on the OCS.
SUBUSAGECAPAMOUNTREMAINING The amount of the spend cap that is remaining on the OCS.
SUBUSAGECAPAMOUNTUSED The amount of the spend cap that has been consumed on the OCS.
SUBUSAGECAPDESCRIPTION The description of the spend cap associated with the OCS notification.
SURNAME This returns the surname.
THRESHOLDAMOUNT The Threshold amount.
THRESHOLDDESCRIPTION The Threshold Description.
THRESHOLDPRORATA The Threshold pro-rata text that is sent with the comm.
TITLE This returns the title.
TODAYSDATE This returns the current date.
TOTALSALESLEDGERADJUSTMENTS This returns the Total Sales Ledger Adjustments.
YOURBILL Static text Your Bill.

These are fields that are available to letter and email velocity templates by default and which do not need to be configured for a particular communication.

VelocityVariableName

Description

ADDRESSLINE1

Address Line 1

ADDRESSLINE2

Address Line 2

ADDRESSLINE3

Address Line 3

ADDRESSLINE4

Address Line 4

ADDRESSLINE5

Address Line 5

POSTCODE

Postcode

FIRSTNAME

First name

SHORTDELIVERYADDRESSNAME

If the address is a company address this is the Company Name

If the address is a personal address this is the Title + FirstName + Middle Name + Surname

The values in default fields are retrieved by JavaClosed A widely used object-oriented programming language that is designed for use in the distributed environment of the internet. It is the most popular programming language for Android smartphone applications beans. The parameters to beans affect how they retrieve data. Beans are generally created over views or tables. This means that with appropriate configuration, any information from tables over which a bean has been created is accessible. In addition, it is also possible to enhance the bean to perform various calculations via methods to perform more complex logic. Fields are denoted by passing the field's attribute to the bean while more complex logic that invokes specific methods on the bean are defined by passing a method attribute to the bean as a parameter. 

Beans have been created over the following tables making all fields on these tables accessible via communications:

Bean Name

Table Name

ACCOUNT

Account (view) - Account Extension + Account Master

ACCOUNTBALANCEBEAN

AccountBalanceView - access to the ledger and more

ACCOUNTPROPERTIES

AccountProperties (view) - access to account attributes and serial numbers

CORPORATEBALANCEBEAN

CorporateBalanceView

GROUPBALANCEBEAN

GroupBalanceView

CREDITDEBITCARDBEAN

CCDCCardDetails

PAYMENTBEAN

Payment, CardPayment, AddressPayment and BankPayment tables

PROPOSITIONBEAN

Mainly over the SubscriptionTariff View and various addition methods to calculate future tariffs etc.

SUBSCRIPTIONBEAN

Subscription (view)

SUBSCRIPTIONPROPERTIES

Managed, Non Managed Serial Numbers, Network Sub Codes and Subscription Attributes

WORKFLOW

Diary Event view (Diary Event and DiaryEventExtension)

The following table lists the default field categories and their corresponding bean IDs and bean parameters. This is how default fields have been set up in Business ConfigurationClosed A module in the CMP Administation console that provides for viewing and modification of business and user applicable system configuration..

FieldCode

Field

Category

Code

Parameter

(case sensitive)

 

BeanID

Explanation

ACCOUNTAMOUNTINQUERY

FINANCIAL

field=amountInQuery

ACCOUNTBALANCE

This returns the value of the balance on the account which is in query.

ACCOUNTBALANCE

FINANCIAL

field=accountBalance

 ACCOUNTBALANCE

This returns the full balance on the account.

ACCOUNTAMOUNTDUE

FINANCIAL

field=amountDue 

 ACCOUNTBALANCE

This returns the balance on the account that is currently due.

ACCOUNTAMOUNTINARREARS

FINANCIAL

field=amountInArrears 

 ACCOUNTBALANCE

This returns the amount on the account that is in arrears.
ACCOUNTTYPE ACCOUNT field=accountType ACCOUNTBEAN This returns the account type of the account.
ACTVTNCODE ESIM field=activationCode RESOURCEATTRIBUTEBEAN The QR code for the eSIM provisioned.
ADDRESSLINE1 DELIVERYADDRESS field=address1 DELIVERYADDRESSBEAN This returns address line 1.
ADDRESSLINE2 DELIVERYADDRESS field=address2 DELIVERYADDRESSBEAN This returns address line 2.
ADDRESSLINE3 DELIVERYADDRESS field=address3 DELIVERYADDRESSBEAN This returns address line 3.
ADDRESSLINE4 DELIVERYADDRESS field=address4 DELIVERYADDRESSBEAN This returns address line 4.
ADDRESSLINE5 DELIVERYADDRESS field=address5 DELIVERYADDRESSBEAN This returns address line 5.
CARDLAST4DIGITS ADVANCE field=textAttribute1 WORKFLOWEVENTATTRIBUTESBEAN The last 4 digits of the payment card that is due to expire.
CONTRACTEXPIRYDATE FINANCIAL field=dateAttribute1 WORKFLOWEVENTATTRIBUTESBEAN The date when the contract is due to expire.

CORPORATETOTALBALANCE

FINANCIAL

field=TotalBalance

CORPORATEBALANCE

The TotalBalance is the SUM of the Posting Account Balance and the Corporate Accounts Balance.

CORPORATETOTALAMOUNTDUE

FINANCIAL

field=TotalAmountDue

CORPORATEBALANCE

The TotalAmountDue is the SUM of the Corporate Posting Account Amount Due and the Corporate Accounts Amount Due.
CURRENTPRICEPLANCHARGE SUBSCRIPTION method=getCurrentPricePlanRecurringCharge PROPOSITIONBEAN The recurring charge for the current price plan.
ENDEDPACKAGEDESCRIPTION FINANCIAL field=packageDescription ENDEDPACKAGEBEAN The description of the package that has been ended.
ENDEDPACKAGECLASSIFICATION FINANCIAL field=packageClassification ENDEDPACKAGEBEAN The classification of the package that has been ended.
ENDEDPACKAGEPRICE FINANCIAL field=price ENDEDPACKAGEBEAN The purchase price of the package that has been ended.
ENDEDPACKAGEPURCHASETIMESTAMP FINANCIAL field=purchaseTimestamp ENDEDPACKAGEBEAN The date and time that the package was originally purchased.
EVENTNUMBER WORKFLOW field=event WORKFLOWBEAN This returns the Event Number.
FORENAME DELIVERYADDRESS field=foreName DELIVERYADDRESSBEAN This returns the forename.
FUTUREPRICEPLANCHARGE SUBSCRIPTION method=getFuturePricePlanRecurringCharge PROPOSITIONBEAN This returns the recurring charge of the future price plan.

GROUPTOTALBALANCE

FINANCIAL

field=TotalBalance

GROUPBALANCE

The TotalBalance is the SUM of the Corporate Posting Account Balance and the Group Accounts Balance.

GROUPTOTALAMOUNTDUE

FINANCIAL

field=TotalAmountDue

GROUPBALANCE

The TotalAmountDue is the SUM of the Group Posting Account Amount Due and the Group Accounts Amount Due.
LATESTPRICEPLANCHARGE SUBSCRIPTION method=getLatestPricePlanRecurringCharge PROPOSITIONBEAN This returns the recurring charge of the latest price plan.
NEXTINVOICEDATE ACCOUNT field=nextInvoiceDate ACCOUNTBEAN This returns the next invoice date.
NEXTPAYMENTAMOUNT ADVANCE field=monetaryAttribute1 WORKFLOWEVENTATTRIBUTESBEAN The amount of the next payment that is due.
NEXTPAYMENTDATE ADVANCE field=dateAttribute1 WORKFLOWEVENTATTRIBUTESBEAN The date when the next payment is due.
ONETIMEPASSWORD WORKFLOWBEAN field=oneOffPassword WORKFLOW This returns the one time password.
POSTCODE DELIVERYADDRESS field=postcode DELIVERYADDRESSBEAN This returns the postcode of the address
RECPREPAYMENTPRODUCT ADVANCE field=textAttribute1 WORKFLOWEVENTATTRIBUTESBEAN The description of the purchased product.
SURNAME DELIVERYADDRESS field=surname DELIVERYADDRESSBEAN This returns the surname.
TITLE DELIVERYADDRESS field=title DELIVERYADDRESSBEAN This returns the title.
TODAYSDATE STATIC Todays date STATICTEXTBEAN Static text to appear on letters.

DEARSIRMADAM

SUNDRY

Dear Sir/Madam

Note: No need for any prefix such as field= or method= here.

STATICTEXT

This returns the text Dear Sir/Madam.

ACCOUNTNUMBER

ACCOUNT

method=accountNumber

ACCOUNT

This returns the account number of the account or of the subscriptions account.

SUBSCRIPTIONNUMBER

SUBSCRIPTION

field=subscriptionNumber

SUBSCRIPTION

This returns the subscription number of the subscription.

SUBSCONNECTEDDATE

SUBSCRIPTION

field=connectedDate

 SUBSCRIPTION

This returns the date that billing commenced.

SUBSDISCONNECTEDDATE

SUBSCRIPTION

field=disconnectedDate

 SUBSCRIPTION

This returns the date that billing stopped.

SUBSTERMINATIONDATE

SUBSCRIPTION

field=subsTerminationDate

 SUBSCRIPTION

This returns the date that the termination invoice was produced.

SUBPASSWORD

SUBSCRIPTION

field=password

 SUBSCRIPTION

This field may be used to store a PIN depending on CMP implementation but it will not store a password of any sort.

SUBCONTRACTSTARTDATE

SUBSCRIPTION

field=contractStartDate

 SUBSCRIPTION

This returns the date that the current subscription contract commenced.

SUBCONTRACTENDDATE

SUBSCRIPTION

method=contractEndDate

 SUBSCRIPTION

The date that the subscriptions contract is due to finish.
SUBSUSERNAME SUBSCRIPTION field=subscriptionUserName SUBSCRIPTION This returns the user name of the subscription.

MOBILELONGESTSUBONACCOUNT

ACCOUNT

method=mobileLongestNonPrepaySub

ACCOUNT

This returns the mobile number of the longest non prepay sub where smsAllowed is true on the network type.

EMAILLONGESTSUBONCMP

ACCOUNT

field=emailLongestNonPrepaySub

ACCOUNT

This is the email of the longest non prepay sub on CMP.

RECURCARDLAST4DIGITS

ACCOUNT

field=ccDcCardNumber

 CREDITDEBITCARDBEAN

This returns the last 4 digits of the credit card that is used for recurring payments.

CARDEXPIRYDATE

ACCOUNT

field=ccDcExpiryDateYYMM

 CREDITDEBITCARDBEAN

This returns the expiry date of the credit or debit card.

BANKACCOUNTNUM

FINANCIAL

field=bankIdentifier, isRecurring=true

DIRECTDEBITMASTERBEAN

This returns the bank account number associated with the direct debit that is active on the account.

BANKACCOUNTIDENTIFIER

FINANCIAL

field=bankAccountIdentifier, isRecurring=true

DIRECTDEBITMASTERBEAN

This returns the bank sort code associated with the direct debit that is active on the account.

NAMEOFPAYER

FINANCIAL

field=NameOfPayer, isRecurring=true

DIRECTDEBITMASTERBEAN

This returns the name of the payer associated with the direct debit that is active on the account.

SUBSERIALNUMBER1

SUBSCRIPTION

type=SSN, networkStatus=CURRENT, Id=1, field=value

SUBSCRIPTIONPROPERTIES

This returns the value of subscription serial number 1.

CHANGINGSUBSERIALNUMBER1

SUBSCRIPTION

type=SSN, networkStatus=CHANGING, Id=1, field=value

SUBSCRIPTIONPROPERTIES

This returns the valud of the changing subscirption serial number 1.

SUBSERIALNUMBER2

SUBSCRIPTION

type=SSN, networkStatus=CURRENT, Id=2, field=value

SUBSCRIPTIONPROPERTIES

This returns the value of subscription serial number 2.

SUBSERIALNUMBER3

SUBSCRIPTION

type=SSN, networkStatus=CURRENT, Id=3, field=value

SUBSCRIPTIONPROPERTIES

This returns the value of subscription serial number 3.

SUBSERIALNUMBER4

SUBSCRIPTION

type=SSN, networkStatus=CURRENT, Id=4, field=value

SUBSCRIPTIONPROPERTIES

This returns the value of subscription serial number 4.

SUBSERIALNUMBER5

SUBSCRIPTION

type=SSN, networkStatus=CURRENT, Id=5, field=value

SUBSCRIPTIONPROPERTIES

This returns the value of subscription serial number 5.

NONMANSERIALNUMBER1

SUBSCRIPTION

type=SSN, networkStatus=CURRENT, Id=6, field=value

SUBSCRIPTIONPROPERTIES

This returns the value of non managed serial number 1.

NONMANSERIALNUMBER2

SUBSCRIPTION

type=SSN, networkStatus=CURRENT, Id=7, field=value

SUBSCRIPTIONPROPERTIES

This returns the value of non managed serial number 2.

NETWORKSUBCODE1

SUBSCRIPTION

type=SNSC, networkStatus=CURRENT, Id=1, field=value

SUBSCRIPTIONPROPERTIES

This returns the value of Subscription network sub code 1.

SUBSCRIPTIONATTRIBUTE1

SUBSCRIPTION

type=SA, Id=001, field=value

SUBSCRIPTIONPROPERTIES

This returns the value of subscription attribute 001.

ACCOUNTSERIALNUMBER1

ACCOUNT

type=ASN,Id=1, networkStatus=CURRENT

ACCOUNTPROPERTIES

This returns the value of Account serial number 1.

ACCOUNTATTRIBUTE1

ACCOUNT

type=ASN,Id=001

ACCOUNTPROPERTIES

This returns the value of Account serial number 1.

FUTUREPRICEPLAN

PROPOSITION

method=FuturePricePlan

PROPOSITION

This returns a future price plan only if there is a pending plan/tariff change.

PREVIOUSPRICEPLAN

PROPOSITION

method=PreviousPricePlan

 

PROPOSITION

This returns a previous price plan if one exists.

CURRENTPRICEPLAN

PROPOSITION

method=CurrentPricePlan

PROPOSITION

Returns the current price plan.

LATESTPRICEPLAN

PROPOSITION

method=LatestPricePlan

PROPOSITION

This is the most recent record, this may be current or future.

RECURRINGPAYMENTREJECTAMT

FINANCIAL

field=MonetaryAttribute1

DIARYEVENTATTRIBUTEBEAN

 

RECURRINGPAUMENTREJECTDATE

FINANCIAL

field=DateAttribute1

DIARYEVENTATTRIBUTEBEAN

 

PAYMENTACCNUM

FINANCIAL

field=AccountNumber

PAYMENT

This is the CMP account number associated with the payment.

PAYMENTDATETIME

FINANCIAL

field=paymentDateTime

PAYMENT

This is the date and time a payment was made.

PAYMENTAMOUNT

FINANCIAL

field=PaymentAmount

PAYMENT

This is the amount of the payment.

PAYCARDLAST4DIGITS

FINANCIAL

field=CardLast4Digits

PAYMENT

This is the last 4 digits of the credit card that made a payment.

CASHTHRESHOLDVALUE

External System

triggerNotificationAttributeName = Cash.Threshold.Value, dataType=Money,field=triggerNotificationAttributeValue, (where Cash.Threshold.Value is the name of the attribute coming from the external system)

dataType=Money - this controls the formatting of the data (e.g. puts €$£ in front of the amount)

 

EXTERNALTRIGGERATTRIBUTES

Actual Consumption of Cash which trigger the notification.
OCSABSOLUTETHRESHOLD OCS triggerNotificationAttributeName=absoluteThreshold EXTERNALTRIGGERATTRIBUTES The absolute value of the threshold that the notification relates to e.g. 200 (MB).
OCSBALANCEID OCS triggerNotificationAttributeName=balanceId EXTERNALTRIGGERATTRIBUTES The identifier of the specific allowance balance that the notification relates to.
OCSCYCLEENDDATE OCS triggerNotificationAttributeName=cycleEndDate EXTERNALTRIGGERATTRIBUTES The end date of the allowance allocation that the notification relates to.
OCSCYCLELENGTH OCS triggerNotificationAttributeName=cycleLength EXTERNALTRIGGERATTRIBUTES The length of the refresh interval for the allowance that the notification relates to e.g. 1 Month.
OCSENTITLEMENTNAME OCS triggerNotificationAttributeName=entitlementName EXTERNALTRIGGERATTRIBUTES Name of the OCS Entitlement that the notification relates to.
OCSREMAININGQUOTA OCS triggerNotificationAttributeName=remainingQuota EXTERNALTRIGGERATTRIBUTES The remaining allowance amount that the notification relates to.
OCSSUBSCRIPTIONID OCS triggerNotificationAttributeName=subscriptionId EXTERNALTRIGGERATTRIBUTES The identifier of the OCS subscription that the notification relates to.
OCSUSAGEAMOUNT OCS triggerNotificationAttributeName=usageAmount EXTERNALTRIGGERATTRIBUTES The amount of allowance consumed that the notification relates to.
OCSVOLUMETHRESHOLDVALUE OCS triggerNotificationAttributeName=volumeThresholdValue EXTERNALTRIGGERATTRIBUTES The percentage value of the threshold that the notification relates to.

OFFERNAME

OCS

triggernotificationAttributeName=Offer.Name, dataType=Text,field=triggerNotificationAttributeValue,

(where Offer.Name is the name of the attribute coming from the external system)

EXTERNALTRIGGERATTRIBUTES

Name of the Offer that the notification relates to.
PACKAGEDESCRIPTION FINANCIAL field=textAttribute1 WORKFLOWEVENTATTRIBUTESBEAN The description of the one-off bolt-on package which is due to expire.
PACKAGEEXPIRYDATE FINANCIAL field=dateAttribute1 WORKFLOWEVENTATTRIBUTESBEAN The date when the one-off bolt-on is due to expire.
PREVIOUSPRICEPLANCHARGE SUBSCRIPTION method=getPreviousPricePlanRecurringCharge PROPOSITIONBEAN This returns the recurring charge of the previous price plan.
PURCHASEPACKAGECLASS FINANCIAL field=packageClassification PURCHASEBEAN The type of the package purchased by the subscriber or agreement administrator.
PURCHASEPACKAGECODE FINANCIAL field=packageCode PURCHASEBEAN The package code that has been purchased by the subscriber or agreement administrator.
PURCHASEPACKAGEDESC FINANCIAL field=packageDescription PURCHASEBEAN The description of the package purchased by the subscriber or agreement administrator.
PURCHASEPACKAGEPRICE FINANCIAL field=price PURCHASEBEAN The price of the package purchased by the subscriber or agreement administrator.
PURCHASEPACKAGETIME FINANCIAL field=purchaseTimestamp PURCHASEBEAN The date and time when the package was purchased by the subscriber or agreement administrator.
RECPREPAYMENTAMOUNT ADVANCE field=monetaryAttribute1 WORKFLOWEVENTATTRIBUTESBEAN The amount of the recurring prepayment.
RECPREPAYMENTDATE ADVANCE field=dateAttribute1 WORKFLOWEVENTATTRIBUTESBEAN The date that the recurring prepayment is due.
RECPREPAYMENTLAST4DIGITS ADVANCE field=textAttribute2 WORKFLOWEVENTATTRIBUTESBEAN The last 4 digits of the card used for the recurring prepayment.
RESOLUTIONREQUIREDBYDATE FINANCIAL field=resolutionReqByDate WORKFLOWBEAN This returns the Resolution Required by Date.
RESOLVEDDATE WORKFLOW field=resolvedDate WORKFLOWBEAN Resolved Date.
SUBALLOWANCEAMOUNT OCS triggerNotificationAttributeName=entitlementSize OCSNOTIFICATIONATTRIBUTES The initial allowance amount allocated for the period on the OCS.
SUBALLOWANCEDESCRIPTION OCS triggerNotificationAttributeName=subscriptionId OCSNOTIFICATIONATTRIBUTES The description of the allowance associated with the OCS notification.
SUBALLOWANCEAMOUNTREMAINING OCS triggerNotificationAttributeName=remainingQuota OCSNOTIFICATIONATTRIBUTES The amount of the allowance remaining on the OCS.
SUBALLOWANCEAMOUNTUSED OCS triggerNotificationAttributeName=usageAmount OCSNOTIFICATIONATTRIBUTES The amount of the allowance that has been consumed on the OCS.
SUBALLOWANCETYPE OCS triggerNotificationAttributeName=subscriptionId OCSNOTIFICATIONATTRIBUTES The type of the allowance associated with the OCS notification.
SUBUSAGECAPAMOUNT OCS triggerNotificationAttributeName=entitlementSize OCSNOTIFICATIONATTRIBUTES The initial spend cap amount defined for the period on the OCS.
SUBUSAGECAPAMOUNTREMAINING OCS triggerNotificationAttributeName=remainingQuota OCSNOTIFICATIONATTRIBUTES The amount of the spend cap that is remaining on the OCS.
SUBUSAGECAPAMOUNTUSED OCS triggerNotificationAttributeName=usageAmount OCSNOTIFICATIONATTRIBUTES The amount of the spend cap that has been consumed on the OCS.
SUBUSAGECAPDESCRIPTION OCS triggerNotificationAttributeName=subscriptionId OCSNOTIFICATIONATTRIBUTES The description of the spend cap associated with the OCS notification.
TOTALSALESLEDGERADJUSTMENTS FINANCIAL field=totalSLAdjustments WORKFLOWBEAN The total Sales Ledger Adjustments.
THRESHOLDAMOUNT FINANCIAL field=thresholdAmount THRESHOLDBEAN The Threshold amount.
THRESHOLDDESCRIPTION FINANCIAL field=thresholdDescription THRESHOLDBEAN The Threshold Description.
THRESHOLDPRORATA FINANCIAL field=thresholdProRata THRESHOLDBEAN The Threshold pro-rata text that is sent with the comm.
YOURBILL STATIC Your bill STATICTEXTBEAN Static text Your bill.
LATESTINVOICEDUEDATE ADVANCE NOTIFICATION field=dateAttribute1 WORKFLOWEVENTATTRIBUTESBEAN The expected payment pull date.